Skip to content

Extension update: [ArrayTools] add Filter, SortStructuresByField, CopyVariable #2004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
BogdanLyopa wants to merge 2 commits into from
Closed

Extension update: [ArrayTools] add Filter, SortStructuresByField, CopyVariable #2004

BogdanLyopa wants to merge 2 commits into from

Conversation

@BogdanLyopa
Copy link
Contributor

@BogdanLyopa BogdanLyopa commented Jan 26, 2026

New Functions for ArrayTools Extension

This PR adds three new useful functions for working with arrays and structures in GDevelop.

📋 Overview

Function Full Name Group Type
CopyVariable Copy variable Scene variables/Array creation Action
Filter Filter array Scene variables/Array manipulation Action
SortStructuresByField Sort structures by field Scene variables/Array manipulation Action

🔄 CopyVariable

Description

Copies a variable (structure or array) completely with all nested fields. Creates a real deep copy without any links.

Parameters

Parameter Type Description
SourceVariable variable Source variable (structure or array) to copy from
TargetVariable variable Target variable (structure or array) to copy to

Usage

Copy variable SourceVariable to TargetVariable

🔍 Filter

Description

Filters an array based on a comparison condition. Can filter arrays of numbers, strings, or structures. If OutputArray is not specified, the input array is mutated.

Parameters

Parameter Type Required Description
SourceArray variable ✅ Array to filter
FieldPath string ❌ Field name or path to check for structures (supports nested fields like "player.score")
Operator stringWithSelector ✅ Comparison operator: ==, !=, >, <, >=, <=
Value string ✅ Value to compare against (can be regex like /pattern/, number, boolean, or text)
OutputArray variable ❌ Output array (leave empty to mutate input array)

Usage

Filter array SourceArray where FieldPath Operator Value into OutputArray

Features

  • ✅ Supports filtering arrays of numbers, strings, and structures
  • ✅ Supports nested fields through dot notation (e.g., "player.score")
  • ✅ Supports different value types:
    • Regex: format /pattern/ (e.g., /^test/)
    • Numbers: automatically recognized
    • Boolean: "true" or "false"
    • Strings: any text
  • ✅ Can work in-place (mutate source array) or create a new array
  • ✅ Supports all standard comparison operators

Examples

Filtering numbers:

Filter array MyArray where "" > "10" into FilteredArray

Filtering structures:

Filter array Players where "score" >= "100" into HighScorers

Filtering with regex:

Filter array Names where "" == "/^John/" into Johns

📊 SortStructuresByField

Description

Sorts an array of structures by a specified field or path. Automatically detects if the value is a number or string and sorts accordingly.

Parameters

Parameter Type Description
Array variable Array of structures to sort
FieldPath string Field name or path to sort by (supports nested fields like "player.score")

Usage

Sort array Array by field FieldPath

Features

  • ✅ Automatically detects value type (number or string) for correct sorting
  • ✅ Supports nested fields through dot notation (e.g., "player.score")
  • ✅ Sorts in-place (mutates source array)
  • ✅ Numbers are always sorted before strings
  • ✅ Works only with arrays of structures

Examples

Sorting by simple field:

Sort array Players by field "score"

Sorting by nested field:

Sort array Players by field "player.stats.level"

✨ Benefits

These functions significantly extend the capabilities of working with arrays and structures in GDevelop:

  • CopyVariable: Allows creating independent copies of data without the risk of accidental changes
  • Filter: Provides a powerful tool for selecting elements from arrays based on complex conditions
  • SortStructuresByField: Simplifies sorting of complex data structures

@BogdanLyopa BogdanLyopa requested a review from a team as a code owner January 26, 2026 10:42
@D8H D8H added 🔄 Extension update An update for an existing extension 🔍 Reviewed extension An extension that is to be reviewed in great detail before merging. labels Jan 26, 2026
4ian
4ian approved these changes Feb 4, 2026
View reviewed changes
extensions/reviewed/ArrayTools.json Outdated
Copy link
Collaborator

@4ian 4ian Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you bump the version to 3.1.0? (the minor update to indicate new features)

Copy link
Contributor Author

@BogdanLyopa BogdanLyopa Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

extensions/reviewed/ArrayTools.json Outdated
Copy link
Collaborator

@4ian 4ian Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a line telling this can now "- clone variables" and one for "- filtering or sorting arrays using fields from (nested) structures"

Copy link
Contributor Author

@BogdanLyopa BogdanLyopa Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

@4ian
Copy link
Collaborator

4ian commented Feb 4, 2026

@BogdanLyopa Slight change of mind on my side but to make it easier for you to maintain this in the future:

  • Could you make these 3 functions into a new AdvancedStructureTools extension? This is motivated by the fact that the "field name" parameters are a bit more advanced than just operations on array (we could consider they are more "structure" related than array).
    You can use a description for this "Advanced Structure Tools" that is similar but limited to just the functions you include.
  • Because this extension will be in the tier "experimental", we will let you push changes to it without an extensive review (so you will just be able to open a PR and we will merge without having strong requirements). This should allow you to be faster in the future when working on this :)

If that's ok with you, you can open a new pull request with a new "AdvancedStructureTools.json" in the experimental tier, which is this folder: https://github.com/GDevelopApp/GDevelop-extensions/tree/main/extensions/community. I understand this will take a bit more of your time today, but I think this should make everyone more agile then.

@BogdanLyopa
Copy link
Contributor Author

BogdanLyopa commented Feb 4, 2026 •
edited
Loading

@BogdanLyopa Slight change of mind on my side but to make it easier for you to maintain this in the future:

  • Could you make these 3 functions into a new AdvancedStructureTools extension? This is motivated by the fact that the "field name" parameters are a bit more advanced than just operations on array (we could consider they are more "structure" related than array).
    You can use a description for this "Advanced Structure Tools" that is similar but limited to just the functions you include.
  • Because this extension will be in the tier "experimental", we will let you push changes to it without an extensive review (so you will just be able to open a PR and we will merge without having strong requirements). This should allow you to be faster in the future when working on this :)

If that's ok with you, you can open a new pull request with a new "AdvancedStructureTools.json" in the experimental tier, which is this folder: https://github.com/GDevelopApp/GDevelop-extensions/tree/main/extensions/community. I understand this will take a bit more of your time today, but I think this should make everyone more agile then.

@BogdanLyopa Slight change of mind on my side but to make it easier for you to maintain this in the future:

  • Could you make these 3 functions into a new AdvancedStructureTools extension? This is motivated by the fact that the "field name" parameters are a bit more advanced than just operations on array (we could consider they are more "structure" related than array).
    You can use a description for this "Advanced Structure Tools" that is similar but limited to just the functions you include.
  • Because this extension will be in the tier "experimental", we will let you push changes to it without an extensive review (so you will just be able to open a PR and we will merge without having strong requirements). This should allow you to be faster in the future when working on this :)

If that's ok with you, you can open a new pull request with a new "AdvancedStructureTools.json" in the experimental tier, which is this folder: https://github.com/GDevelopApp/GDevelop-extensions/tree/main/extensions/community. I understand this will take a bit more of your time today, but I think this should make everyone more agile then.

@4ian Thanks for the suggestion — that makes sense 👍
I’ve already created a new pull request with a separate AdvancedStructureTools #2014

@BogdanLyopa BogdanLyopa closed this Feb 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@4ian 4ian 4ian approved these changes

Assignees

No one assigned

Labels

🔄 Extension update An update for an existing extension 🔍 Reviewed extension An extension that is to be reviewed in great detail before merging.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@BogdanLyopa @4ian @D8H